home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 5 / Amiga Tools 5.iso / grafik / gfx cards / cgwbpat107 / cgwbpattern.man < prev    next >
Text File  |  1996-07-16  |  12KB  |  456 lines
  1. CGWBPattern                        Manual                            CGWBPattern
  2.  
  3.     NAME
  4.     
  5.       CGWBPPatch           - Main program
  6.  
  7.       Prefs/CGWBPattern  - Prefs
  8.     
  9.     
  10.     INTRODUCTION
  11.     
  12.         CyberGraphics has the wonderful feature that you can have a Workbench
  13.         with a serious quantity of colours.. Ever since i got my graphics card
  14.         and CyberGraphics i wanted to have a jpeg as a backdrop.. Would sure
  15.         look pretty, So i started to write CGWBPattern, and with the writing
  16.         it grew until it turned into what it is now.. A complete replacement
  17.         for WBPattern, with additional gimics ;-)
  18.  
  19.  
  20.     FEATURES
  21.         
  22.         Backdrop (pattern) updating (refreshing) is significantly faster then
  23.         WBPattern.
  24.  
  25.         Uses datatypes to load patterns
  26.  
  27.         6 different colour remap types (precisions).
  28.  
  29.         Change the Screenmode and the backdrop remaps to the new number of
  30.         colours to insure the backdrops always look as good as possible.
  31.  
  32.         CyberGraphics users can have 15/16/24bit backdrops using the
  33.         24bit picture.datatype.
  34.     
  35.         Optional random backdrops.
  36.  
  37.         Workbench windows can be changed to smart refresh for even faster
  38.         pattern updating
  39.  
  40.         FullWB toggle (with optional 'screen-to-front/back' gadget)
  41.  
  42.         Prefs program for easy setting.
  43.  
  44.         Memory used by patterns can be varied.
  45.  
  46.         Optional Centering
  47.  
  48.         3 placement types - pattern can be tiled, not tiled or scaled to
  49.         the size of the Workbench        
  50.  
  51.     INSTALLATION
  52.  
  53.         One off
  54.         
  55.         1. Copy bgui.library to libs: or do 'assign libs: libs add' from
  56.             the CGWBPattern dir.
  57.         
  58.         2.    Just execute 'CGWBPPatch' then play with the prefs prog.
  59.     
  60.         Perminant
  61.         
  62.         1. Open up WBPattern prefs, set to blank patterns.. Save (otherwise
  63.             you'll waste mem.).
  64.  
  65.         2. Copy Prefs/CGWBPattern to whereever you put your prefs progs.
  66.         
  67.         3. Copy bgui.library to libs:
  68.  
  69.         4. Copy CGWBPPatch to c: or whereever.
  70.  
  71.         5. Add 'CGWBPPatch' to your startup-sequence sometime <after>
  72.             'AddDatatypes' (it auto-detaches so no need to run it..).
  73.             
  74.         6. Play with the Prefs prog.      
  75.  
  76.     
  77.     USAGE
  78.     
  79.         CGWBPPatch
  80.  
  81.             Execute it once to patch the system, once more to remove the
  82.             patches (NB this can be dangerous.. If another program has
  83.             patched the same functions your system may guru).        
  84.         
  85.         Prefs/CGWBPattern
  86.         
  87.          - Gadgets (all have keyboard shortcuts)
  88.         
  89.              Workbench/Windows
  90.                  
  91.                  'Directory' ('Random' checked)
  92.                  
  93.                      Directory name from which the patterns are chosen, either
  94.                     enter by hand or click on the file requester gadget.
  95.  
  96.  
  97.                 'Pattern' ('Random' not checked)
  98.  
  99.                     Pattern to use, either enter by hand or click on the file
  100.                     requester gadget.
  101.                 
  102.  
  103.                 'Precision'
  104.                 
  105.                     Remap precision to use. the higher the precision the better
  106.                     the backdrops will look, however the higher the precision the
  107.                     longer the backdrops will take to load.. Experiment.
  108.                     
  109.                         Precision
  110.  
  111.                         worst -----> best
  112.                         
  113.                         GUI (1) -> Icon (2) -> Image (3) -> Exact (4)
  114.                         
  115.                         The Precisions are in this order in the cycle gad.
  116.                     
  117.                     Planes precision is no remapping at all.. Useful if, for
  118.                     example, you use MagicWB with only 8 colours and your
  119.                     patterns use these colours in the same order as the WB -
  120.                     Remapping, in this case, is not ness. so why not switch it
  121.                     off and gain some speed in loading?
  122.  
  123.                     Another use that springs to mind.. Seen those ArcPacks?
  124.                     with about 10ish different sets of colours... Rather
  125.                     than make a new copy of the pattern with different colours
  126.                     just change the WB Colours..
  127.                                         
  128.                     
  129.                     CyberGfx precision is only usable by those with CyberGraphics
  130.                     supported Graphics Cards.. Allows you to use 15/16/24 bit
  131.                     patterns (backdrops).
  132.                     
  133.  
  134.                 'Smart'
  135.                 
  136.                     Check this if you want the Workbench Window (or the Drawer
  137.                     windows) to be smart refresh instead of simple refresh -
  138.                     Smart refresh windows are faster to refresh but take up
  139.                     more memory.
  140.                     
  141.                     Don't check 'Smart' for the Workbench if you're in a
  142.                     CyberGraphics screemode with a depth greater than 8.
  143.                 
  144.  
  145.                 'Random'
  146.                 
  147.                     Check this if you want random patterns.
  148.                     
  149.                     A random pattern will be loaded each time the prefs changes
  150.                     (apart from 'WB Gadget' - toggling this has no effect on the
  151.                     patterns) or is read by CGWBPPatch (ie on startup or if you
  152.                     change the screenmode).
  153.                 
  154.                 'Position'
  155.  
  156.                     3 Positions available
  157.  
  158.                     'Tile' tiles the pattern across the WB/Window
  159.  
  160.                     'Picture' doesn't tile the pattern, and fills the rest of
  161.                      the display with the colour at the topleft corner of the
  162.                      pattern.
  163.  
  164.                     'Scale' is the same as 'Picture' only the
  165.                     pattern is scaled to the size of the WB Screen
  166.  
  167.                     NB if there's not enough memory free to scale the picture
  168.                     'Scale' falls back to 'Picture', if 'Picture' fails then
  169.                     'Tile' is tried.
  170.                     
  171.                     Although it is perfectly ok to 'Scale' or 'Picture' a
  172.                     pattern for drawers, the two use the size of the screen
  173.                     rather than the current window.  This is unlikely to change
  174.                     as if CGWBPattern did a 'Scale' or 'Picture' for every window
  175.                     opening it would make your WB rather slow.
  176.                     
  177.                 'Center Y'
  178.  
  179.                     Check this and the pattern will be vertically centered within
  180.                     each window.
  181.  
  182.                 'Center X'
  183.  
  184.                     Check this and the pattern will be horozonally centered within
  185.                     each window.    
  186.  
  187.             'Full WB'
  188.  
  189.                 Check this and the Workbench titlebar will be hidden (the
  190.                 Workbench pattern will occupy the whole screen).
  191.             
  192.                 This only makes sence if the Workbench window is borderless.
  193.                 
  194.                 NB CGWBPattern uses electronic countermeasures ;-) to make
  195.                 sure the Workbench stays full or not. If you have several
  196.                 programs that toggle 'Full WB' running, the important one
  197.                 is this (trust me).
  198.                     
  199.  
  200.             'WB Gadget'
  201.  
  202.                 If you have a 'Full WB' but you want a 'Screen to front/back'
  203.                 gadget anyway check this.
  204.  
  205.     
  206.             'Mem Size'
  207.  
  208.                 Controls the way CGWBPattern allocates the memory for the
  209.                 patterns..
  210.  
  211.                     'Minimum'
  212.  
  213.                         Smallist allocation - least memory taken.. Slowest
  214.                         refresh.
  215.  
  216.                     'Standard'
  217.  
  218.                         Normal memory allocation. Normal refresh
  219.  
  220.                     'Maximum'
  221.  
  222.                         Largest memory allocation, fastest refresh.
  223.  
  224.             
  225.             'Save'
  226.  
  227.                 Saves the current settings to env: & envarc:
  228.  
  229.  
  230.             'Use'
  231.  
  232.                 Saves the current settings to env: (reboot and you'll
  233.                 get the old settings back)
  234.  
  235.  
  236.             'Test'                    
  237.                     
  238.                 Shows you what the current settings look like without commiting
  239.                 you to them (when you quit the prefs the prevous settings will
  240.                 be restored).
  241.     
  242.     
  243.             'Cancel'
  244.  
  245.                 Quit the preferences loosing any changes made.                    
  246.                     
  247.     
  248.          - Menus
  249.         
  250.             'Project'
  251.  
  252.                 'Open...'
  253.                 
  254.                     Load a previously saved prefs file.
  255.  
  256.                 'Save as...'
  257.                 
  258.                     Save the prefs as..
  259.  
  260.                 'About...'
  261.                 
  262.                     Pretty little window.
  263.  
  264.                 'Quit'
  265.                     
  266.                     Quit the preferences loosing any changes made.    
  267.                     
  268.  
  269.             'Edit'
  270.  
  271.                 'Last Saved'
  272.                 
  273.                     Re-loads the preferences from envarc:
  274.  
  275.                 'Restore'         
  276.                 
  277.                     Re-loads the preferences from env:
  278.  
  279.     
  280.     BUGS/PROBLEMS
  281.     
  282.         If you change a drawer to 'View by Icon' without closing/re-opening
  283.         the drawer, currently the pattern will not appear.
  284.         
  285.         CGWBPattern does not work with EGS (this <MAY> be changed).
  286.         I don't use it with EGS and no-one has yet written to me saying
  287.         that they do (well want to..).
  288.         
  289.         Yak Users:
  290.         
  291.         The FullWB in CGWBPattern & the FullWB in Yak sometimes do not get
  292.         on.. If you have FullWB set in CGWBPattern but not in Yak then you'll
  293.         sometimes get a visable titlebar. The thing to do is set FullWB in Yak
  294.         to TRUE (even if you don't want a full wb) and forget it. If you want a
  295.         full Wb tick FullWB in CGWBPattern, if you don't don't.
  296.         
  297.         Other FullWB Programs:
  298.         
  299.         In general won't actually do anything (although some <may> have a similar
  300.         problem to Yak).
  301.  
  302.  
  303.    SPECIAL REQUIREMENTS
  304.  
  305.        Needs OS 3.00 or higher.
  306.        CyberGraphics, Supported Gfx Card & the 24bit picture.datatype
  307.         to use the 15/16/24bit Precision.
  308.         bgui.library needed for preferences editor (included).
  309.  
  310.  
  311.     DISTRIBUTION
  312.     
  313.         CGWBPatternXXX (dir)
  314.  
  315.           Prefs (dir)
  316.             CGWBPattern
  317.                 CGWBPattern.info
  318.                 
  319.           CGWBPPatch
  320.              CGWBPattern.man
  321.            CGWBPatternXXX.readme
  322.  
  323.  
  324.  
  325.           libs (dir)
  326.             bgui.library         (c) Jan van den Baard
  327.  
  328.              Calvin.iff24                (c) Unknown
  329.              Planet.iff24                (c> Unknown
  330.  
  331.    AUTHOR
  332.  
  333.       Simon Richardson
  334.       simon@albert.demon.co.uk
  335.  
  336.  
  337.    COPYRIGHT
  338.  
  339.       Simon Richardson 1995.
  340.  
  341.  
  342.    PRICE
  343.  
  344.       CGWBPattern is emailware (if you like it let me know)
  345.  
  346.  
  347.    DISTRIBUTABILITY
  348.  
  349.       Freely Distributable, (c) 1994-95 Simon Richardon
  350.  
  351.  
  352.    DISCLAMER
  353.  
  354.         Standard boring disclamer that no-one reads anyway, about everything
  355.         being due to the law of chance and not my fault at all (and definitly
  356.         not my resposibility).. You know the old "use at your own peril" thingy..
  357.         Humm do you think they put that on razors? "If you accidently cut off part
  358.         of your body with this thing, or it explodes etc etc..". Makes you wonder
  359.         doesn't it?
  360.  
  361.       If you like it, use it.. If you hate it delete it.
  362.  
  363.  
  364.    HISTORY
  365.  
  366.     1.0     26/10/95 First version
  367.  
  368.  
  369.     1.01     26/10/95    (First Aminet release)
  370.       
  371.                          Can now set the window refresh type (NB don't make CGfx
  372.                         windows smart refresh)
  373.  
  374.                         Can optionally remove the Workbench title bar
  375.     
  376.     CGWBPPatch                    
  377.  
  378.         1.02    04/01/96        Added electronic contermeasures ;-)
  379.                                 BugFix: CGWBPPatch now unload patterns before quiting
  380.                                 (oops).
  381.                                 Only resets the WB if it needs to rather than every
  382.                                 time its prefs changes.
  383.                                 Added WB Gadget
  384.                                 The Workbench window always has its own pattern even
  385.                                 if its not borderless now.
  386.                                 'View by name' now works correctly
  387.                                 CGWBPPatch now detaches from the CLI again.
  388.                                 Now loads random files.
  389.                                 Changed the name slightly for clarity.
  390.                                 Misc small code changes and optimisations
  391.                                 
  392.         1.03    06/01/96        (Aminet Release)
  393.         
  394.                                 BugFix: Solved problem with stacksize caused by the
  395.                                 additional code for random patterns.
  396.                                 
  397.         1.04                    Added Planes precision
  398.  
  399.         1.041    14/01/96        BugFix: ShowTitle() would reset the WB sometimes
  400.                                 when unness.
  401.                                 
  402.         1.05    23/01/96        Now uses 24bit picture.datatype for CyberGfx
  403.                                 precision (also reduces code size & speeds
  404.                                 up loading & refreshing slightly..)    
  405.  
  406.         1.06    29/01/96        Fixed the two enforcer hits that the patch was causing
  407.                                 (haven't had a hit for some days now, so hopefully
  408.                                 they're all gone..)
  409.  
  410.                                 Some internal modifications
  411.  
  412.                                 Fixed offset problem which caused the patterns to be
  413.                                 incorrectly refreshed if a drawer was moved & enlarged.
  414.  
  415.                                 Added code for centering & positioning    
  416.  
  417.         1.07    07/02/96        BugFix: The positioning of the pattern on the WB Window
  418.                                 was sometimes incorrect.
  419.  
  420.                                 Preferences loading re-written, now faster & much nicer
  421.                                 (unfortunatly also incompatable with previous releases).
  422.                                 Which should fix the problems some people where having.
  423.  
  424.                                 Code has been optimised some more & modified in places.
  425.  
  426.                                 Workbench now resets only when a preferences change makes
  427.                                 it nessesary.
  428.  
  429.                                 FullWB handling changed.. Only resets if it has to.                
  430.                                 
  431.                                 
  432.     Prefs/CGWBPattern
  433.  
  434.         1.02    17/12/95        Added new gadgets, tided up GUI.
  435.  
  436.         1.03    03/01/96        Filename gadget now knows about dirs.
  437.  
  438.         1.04                  Added Planes precision.    
  439.  
  440.         1.05    24/01/96        Added gadgets & code for positioning & centering
  441.  
  442.         1.06    04/02/96        Preferences saving/loading re-written.    Which should fix
  443.                                 the problems some people where having (also faster).
  444.  
  445.                                                         
  446.  
  447.    THANKS
  448.  
  449.         Jan van den Baard for  BGUI Library, i thought i'd try it for the
  450.         prefs editor.. Now i love it..
  451.  
  452.         Pierre Carrette & Walter Dörwald for your excellent 'layerhook'
  453.         example.
  454.  
  455.  
  456.